home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / gth035.zip / HOST.HLP < prev    next >
Text File  |  1990-08-11  |  10KB  |  293 lines
  1.  
  2. ╔═════════╦════════════════════════════════════════════════════════════
  3. ║ GT-HELP ║ HOST.BAT - the Batch file which starts GT from DOS
  4. ╚═════════╩════════════════════════════════════════════════════════════
  5.  
  6.  
  7.     The HOST.BAT should :
  8.  
  9.     a)      execute GT with appropriate parameters, including starting a
  10.             script to put GT into Host Mode.
  11.  
  12.                 see below
  13.  
  14.     b)      handle any scheduled exits that you may have defined in
  15.             SCHEDULE.BBS or error exits which may occur due to problems
  16.             which GT detects.
  17.  
  18.  
  19.     Further details on executing GT and handling exits for error conditions
  20.     and scheduled events are described in the detailed sections below.
  21.  
  22.  
  23. ┌──────────────────────┐
  24. │ Location of HOST.BAT │
  25. └──────────────────────┘
  26.  
  27.     Anywhere in the DOS path is suitable for GT.
  28.  
  29.     If you create it with GT-Help, it will go into the main GT directory.
  30.     Similarly, that is where GT-Help will look if you want to edit it.
  31.  
  32.     If you already have a HOST.BAT elsewhere, and decide to copy it into
  33.     the GT directory, remember also to delete the original copy otherwise
  34.     you are likely to be confused by it later.
  35.  
  36.  
  37. ┌───────────────────────────────────┐
  38. │ The GT command line for Host Mode │
  39. └───────────────────────────────────┘
  40.  
  41.     The main instruction is GT1550 or GR1550 (whichever version you are
  42.     using).  This will usually be followed by several parameters and
  43.     switches :
  44.  
  45.        ┌─────────────────────────────────── Program to execute
  46.        │        ┌────────────────────────── Registration Code
  47.        │        │      ┌─────────────────── Answer ring count
  48.        │        │      │    ┌────────────── Overlay instructions
  49.        │        │      │    │   ┌────────── Other switches if required
  50.     ┌──┴─┐ ┌────┴───┐ ┌┴┐ ┌─┴─┐ │   ┌────── Name of a GT script to execute
  51.     │    │ │        │ │ │ │   │ │ ┌─┴┐
  52.     GR1550 *xxxx-xxxx /R2 /V:ED   host
  53.  
  54.     If the SCHEDULE.BBS contains QUIT instructions, then this instruction
  55.     must be followed by one or more errorlevel instructions to process the
  56.     appropriate scheduled events.
  57.  
  58.     Remember that the HOST.BAT in the GT sample zip may be for GT1550 not
  59.     GR1550. So you will need to change the T to R if you are using the GR
  60.     version.
  61.  
  62.  
  63.     GT REGISTRATION CODE
  64.  
  65.         The registration code skips the startup delay.  In 1550 it will
  66.         begin with an asterisk, which should be included.  Omit the
  67.         registration code if you have not yet registered for GT.
  68.  
  69.         To register, please see the registration documents (GT-INST
  70.         installs these in the DOC subdirectory of your GTPATH).
  71.  
  72.  
  73.     THE ANSWER RING COUNT
  74.  
  75.         /R followed by a digit, specifying how many rings GT should wait
  76.         before answering the phone.
  77.  
  78.         This parameter should appear only if you are having GT control the
  79.         answering (the recommended way for most modems).
  80.  
  81.         Note:   With a hayes-compatible modem this involves leaving S0=0 in
  82.                 host mode and using ATA| as the answer string.  The
  83.                 configurations in the GT-Help modem library do this where
  84.                 possible.
  85.  
  86.         Leaving it out is *always* safe - GT will default to 2 rings.
  87.  
  88.  
  89.     OVERLAY CLASSIFICATION
  90.  
  91.         V: followed by any of:
  92.  
  93.             D   if *any* DOOR batch files are to be overlaid
  94.                     (you can specify which doors in the DOORS.BBS file)
  95.  
  96.             E   if *any* external protocols are to be overlaid
  97.                     (you can specify which protocols with the ALT-I
  98.                     configuration)
  99.  
  100.             L   if logon/logoff doors are to be overlaid
  101.  
  102.  
  103. ┌─────────────────────────┐
  104. │ OTHER POSSIBLE SWITCHES │
  105. └─────────────────────────┘
  106.  
  107.     a)  If using non-standard COMMS ports :
  108.  
  109.             /2 $03C2    Reassign COM2 to hex address 03C2.
  110.  
  111.             /2 $03C2:2  Reassign COM2 to hex address 03C2 and instead of
  112.                             the normal IRQ3, use IRQ2.
  113.  
  114.  
  115.     b)  To change the sound frequency of alarms and duration of beeps :
  116.  
  117.             /L4:150
  118.  
  119.         The first number (4) controls the frequency of alarms (0 is lowest, 9
  120.         highest). The second number controls the duration of beeps in
  121.         milliseconds (default 225).
  122.  
  123.  
  124.     c)  To control the keyboard timeout period (in minutes, default 10) :
  125.  
  126.             /T5     for a 5 minute keyboard timeout
  127.  
  128.         The keyboard timeout is used if you log on locally and get
  129.         distracted - GT will automatically log you out when this
  130.         period expires.
  131.  
  132.  
  133.     d)  To control the default action for Mailchecks :
  134.  
  135.             /M      suppresses the check for mail prompt
  136.             /MN     retains the prompt, but makes the default answer NO.
  137.  
  138.  
  139.     e)  To control beeps and pages :
  140.  
  141.             /Q      silences beeps and pages
  142.             /S      silences beeps but allows pages to be heard
  143.  
  144.  
  145.     f)  To begin logging to a printer :
  146.  
  147.             /P
  148.  
  149.     g)  If you also use the same line for voice calls or an answering
  150.         machine :
  151.  
  152.             /RB10:30
  153.  
  154.         would configure for ringback operation (GT would answer only if a
  155.         second call comes in between 10 and 30 seconds after the first).
  156.         In this mode, callers have to know that they must dial, allow the
  157.         phone to ring, hang up quickly and call back immediately - which
  158.         can be tricky.  Times are adjustable - the upper limit is 45
  159.         seconds.
  160.  
  161.  
  162. ┌───────────────────┐
  163. │ Unlikely Switches │
  164. └───────────────────┘
  165.  
  166.     There may be occasions when you want these switches, but they would not
  167.     normally be appropriate when running the board in HOST mode.
  168.  
  169.             /D      would leave DTR high when GT exits.
  170.  
  171.             /C      would pretend you were connected by direct cable to the
  172.                     caller, rather than by modem.
  173.  
  174.             /K      would put GT into capture mode - not practical for host
  175.                     working since GT cannot be overlaid while capture is
  176.                     on.
  177.  
  178.  
  179. ┌────────────────┐
  180. │ STARTUP SCRIPT │
  181. └────────────────┘
  182.  
  183.     The startup script is essential to get GT into host mode.  In its
  184.     simplest (and usual) form it consists of a file named HOST.SCR in the
  185.     GTPATH which contains only the word
  186.  
  187.             HOST
  188.  
  189.  
  190. ┌────────────────────────────┐
  191. │ Scheduled Event Processing │
  192. └────────────────────────────┘
  193.  
  194.     Scheduled events can be processed by a QUIT instruction in GT's
  195.     SCHEDULE.BBS.
  196.  
  197.     When a scheduled quit event matures, GT exits with a defined return
  198.     code (known as an errorlevel, though in GT's case its not an error
  199.     condition).  GT will also exit with errorlevel 1 under error conditions.
  200.  
  201.     If you have more than one errorlevel to test for, you must test for the
  202.     highest one first - and must also make sure that you branch over any
  203.     later errorlevel tests.  In most cases though you only need something
  204.     fairly simple :
  205.  
  206.  
  207.     a)  If you are running GR1550 and not running netmail, you probably
  208.         don't need to be concerned with scheduled events.  It is
  209.         nevertheless useful to be able to take appropriate action if GT
  210.         exits with an errorlevel 1, eg :
  211.  
  212.             :gtagain
  213.             GR1550 params ....
  214.             if errorlevel 1 goto gtagain
  215.  
  216.         or preferably :
  217.  
  218.             GR1550 params ....
  219.             if errorlevel 1 reboot
  220.  
  221.         (the latter assuming the availability of a DOS program REBOOT which
  222.         you can find on many BBs).
  223.  
  224.                               
  225.     b)  If you are running GR1550, and using netmail scheduled by the QUIT
  226.         6 command, then you also need to
  227.  
  228.         i)  detect the errorlevel 6 and execute the netmail batch file from
  229.             it
  230.  
  231.         ii) arrange to re-execute GR1550 afterwards.
  232.  
  233.         for example :
  234.  
  235.             :gtagain
  236.             GR1550 params ....
  237.             if errorlevel 6 goto net
  238.             if errorlevel 1 goto reboot         (or to gtagain if no reboot)
  239.             goto gtdone
  240.  
  241.             :net
  242.             netmail
  243.             goto gtagain
  244.  
  245.             :reboot
  246.             reboot
  247.  
  248.             :gtdone
  249.  
  250.  
  251.     c)  If you are running GT15, then you *also* have to allow for a QUIT
  252.         255 which GT executes when a caller disconnects after executing a
  253.         batch file.  When that is seen, GT must be restarted.
  254.  
  255.         for example :
  256.  
  257.             :gtagain
  258.             GR1550 params ....
  259.             if errorlevel 255 goto gtagain
  260.             if errorlevel 6 goto net
  261.             if errorlevel 1 goto reboot         (or to gtagain if no reboot)
  262.             goto gtdone
  263.  
  264.             :net
  265.             netmail
  266.             goto gtagain
  267.  
  268.             :reboot
  269.             reboot
  270.  
  271.             :done
  272.  
  273.  
  274.     Examples b) and c) both execute NETMAIL.BAT which is expected to exist
  275.     somewhere in the DOS path.  See the Netmail menu for instructions on
  276.     creating this.
  277.  
  278.  
  279. ┌──────────┐
  280. │ Reminder │
  281. └──────────┘
  282.  
  283.     When adding/editing errorlevel instructions, be sure to
  284.  
  285.     a)  test for them in strict DESCENDING errorlevel order, and
  286.  
  287.     b)  branch over any subsequent errorlevel tests.
  288.  
  289.     Also, remember that you cannot execute any other DOS programs between
  290.     the GT program and the errorlevel tests, which might change the
  291.     errorlevel.
  292.  
  293.